<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>scutimer: Scutimer_v2_1</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">scutimer
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Scutimer_v2_1</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaac033729416a2ae86fec784a89a4c653"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gaac033729416a2ae86fec784a89a4c653">XScuTimer_IsExpired</a>(InstancePtr)</td></tr>
<tr class="separator:gaac033729416a2ae86fec784a89a4c653"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1976650946668999ca5107fef691e53"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gaf1976650946668999ca5107fef691e53">XScuTimer_RestartTimer</a>(InstancePtr)</td></tr>
<tr class="separator:gaf1976650946668999ca5107fef691e53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94fbce5d53f983ec5cf675cfc97f4f78"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer</a>(InstancePtr,  Value)</td></tr>
<tr class="separator:ga94fbce5d53f983ec5cf675cfc97f4f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga494afe8a54f75991a1e63fcef913df41"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga494afe8a54f75991a1e63fcef913df41">XScuTimer_GetCounterValue</a>(InstancePtr)</td></tr>
<tr class="separator:ga494afe8a54f75991a1e63fcef913df41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54fc490ff5bdcfa76eddddf5fc5dc5bf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga54fc490ff5bdcfa76eddddf5fc5dc5bf">XScuTimer_EnableAutoReload</a>(InstancePtr)</td></tr>
<tr class="separator:ga54fc490ff5bdcfa76eddddf5fc5dc5bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29b90dcea87e70190d47c53e89977c8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga29b90dcea87e70190d47c53e89977c8a">XScuTimer_DisableAutoReload</a>(InstancePtr)</td></tr>
<tr class="separator:ga29b90dcea87e70190d47c53e89977c8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41e184373a4d02ce8a9aec1601a52c04"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga41e184373a4d02ce8a9aec1601a52c04">XScuTimer_EnableInterrupt</a>(InstancePtr)</td></tr>
<tr class="separator:ga41e184373a4d02ce8a9aec1601a52c04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3ea67683ec802381c4aef819d04768b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gac3ea67683ec802381c4aef819d04768b">XScuTimer_DisableInterrupt</a>(InstancePtr)</td></tr>
<tr class="separator:gac3ea67683ec802381c4aef819d04768b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab653a0c97cfb913f3cabeaa3a9167586"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gab653a0c97cfb913f3cabeaa3a9167586">XScuTimer_GetInterruptStatus</a>(InstancePtr)</td></tr>
<tr class="separator:gab653a0c97cfb913f3cabeaa3a9167586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc11e29fe8f755683fbc6edc883e0a4d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gadc11e29fe8f755683fbc6edc883e0a4d">XScuTimer_ClearInterruptStatus</a>(InstancePtr)</td></tr>
<tr class="separator:gadc11e29fe8f755683fbc6edc883e0a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3cd5f68d2ce17dd72a4abaf4afe06a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gae3cd5f68d2ce17dd72a4abaf4afe06a6">XScuTimer_SetLoadReg</a>(BaseAddr,  Value)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>, (Value))</td></tr>
<tr class="separator:gae3cd5f68d2ce17dd72a4abaf4afe06a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3eedf4e335232d3303b1fd3927f10213"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga3eedf4e335232d3303b1fd3927f10213">XScuTimer_GetLoadReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>)</td></tr>
<tr class="separator:ga3eedf4e335232d3303b1fd3927f10213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga162738ee853ef5fc9c4fa35bf9c2bb8d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga162738ee853ef5fc9c4fa35bf9c2bb8d">XScuTimer_SetCounterReg</a>(BaseAddr,  Value)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>, (Value))</td></tr>
<tr class="separator:ga162738ee853ef5fc9c4fa35bf9c2bb8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65cf8fca671de7e21a9944c43bf7cd8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga65cf8fca671de7e21a9944c43bf7cd8a">XScuTimer_GetCounterReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>)</td></tr>
<tr class="separator:ga65cf8fca671de7e21a9944c43bf7cd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0b71c6aa97a846b93c4a5fa2092be9e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gae0b71c6aa97a846b93c4a5fa2092be9e">XScuTimer_SetControlReg</a>(BaseAddr,  Value)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, (Value))</td></tr>
<tr class="separator:gae0b71c6aa97a846b93c4a5fa2092be9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1427e7cc324917e9bc062ea9cc1976ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga1427e7cc324917e9bc062ea9cc1976ac">XScuTimer_GetControlReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>)</td></tr>
<tr class="separator:ga1427e7cc324917e9bc062ea9cc1976ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffc9febb953169fb57818c4c58fd68fc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gaffc9febb953169fb57818c4c58fd68fc">XScuTimer_SetIntrReg</a>(BaseAddr,  Value)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>, (Value))</td></tr>
<tr class="separator:gaffc9febb953169fb57818c4c58fd68fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48d158b4cc15416e7d4a62867720b79a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga48d158b4cc15416e7d4a62867720b79a">XScuTimer_GetIntrReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>)</td></tr>
<tr class="separator:ga48d158b4cc15416e7d4a62867720b79a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4c784baaac425e11d6a1184ae44b349"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr,  RegOffset)&#160;&#160;&#160;Xil_In32((BaseAddr) + (RegOffset))</td></tr>
<tr class="separator:gae4c784baaac425e11d6a1184ae44b349"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f29815a4f21529bfc3d009932d3c2fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr,  RegOffset,  Data)&#160;&#160;&#160;Xil_Out32((BaseAddr) + (RegOffset), (Data))</td></tr>
<tr class="separator:ga6f29815a4f21529bfc3d009932d3c2fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga59badd651be237aab4099cedd96621d2"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga59badd651be237aab4099cedd96621d2">XScuTimer_CfgInitialize</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, <a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr class="separator:ga59badd651be237aab4099cedd96621d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf24fad576d3adab4b53eebdef424bde"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gabf24fad576d3adab4b53eebdef424bde">XScuTimer_Start</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr class="separator:gabf24fad576d3adab4b53eebdef424bde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac0376fbfeb5c29bb44403d6fefd0843"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gaac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr class="separator:gaac0376fbfeb5c29bb44403d6fefd0843"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac6cd65141b00c0d1940d0b8f2a081faf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, u8 PrescalerValue)</td></tr>
<tr class="separator:gac6cd65141b00c0d1940d0b8f2a081faf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56d8c36e4aa28168de3ba5d7f87feb2d"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga56d8c36e4aa28168de3ba5d7f87feb2d">XScuTimer_GetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr class="separator:ga56d8c36e4aa28168de3ba5d7f87feb2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e7db0f5795151c2d6538dae1fd07a16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#ga1e7db0f5795151c2d6538dae1fd07a16">XScuTimer_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga1e7db0f5795151c2d6538dae1fd07a16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3036b3f9f6e7735d3e6a6eb74a28e95"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr class="separator:gac3036b3f9f6e7735d3e6a6eb74a28e95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gadc11e29fe8f755683fbc6edc883e0a4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_ClearInterruptStatus</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr,              \</div>
<div class="line">                <a class="code" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>, <a class="code" href="group__scutimer__v2__1.html#gafa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a>)</div>
<div class="ttc" id="group__scutimer__v2__1_html_gafa21717c99e101943a7075d4e2e30ca1"><div class="ttname"><a href="group__scutimer__v2__1.html#gafa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a></div><div class="ttdeci">#define XSCUTIMER_ISR_EVENT_FLAG_MASK</div><div class="ttdoc">Event flag. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:101</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga6f29815a4f21529bfc3d009932d3c2fe"><div class="ttname"><a href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a></div><div class="ttdeci">#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)</div><div class="ttdoc">Write to the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:276</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga79f4aab3a1968e66ae1fadb846e7b8c8"><div class="ttname"><a href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_ISR_OFFSET</div><div class="ttdoc">Timer Interrupt Status Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:78</div></div>
</div><!-- fragment -->
<p>This function clears the interrupt status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gadc11e29fe8f755683fbc6edc883e0a4d" title="This function clears the interrupt status. ">XScuTimer_ClearInterruptStatus(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaeaf7add0552b3b0c5ab78b6668a88d6a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK&#160;&#160;&#160;0x00000002U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Auto-reload. </p>

</div>
</div>
<a class="anchor" id="ga242deea9cc62049619bdfd97e7a731f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_CONTROL_ENABLE_MASK&#160;&#160;&#160;0x00000001U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Timer enable. </p>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest()</a>, <a class="el" href="group__scutimer__v2__1.html#gabf24fad576d3adab4b53eebdef424bde">XScuTimer_Start()</a>, and <a class="el" href="group__scutimer__v2__1.html#gaac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop()</a>.</p>

</div>
</div>
<a class="anchor" id="ga62c9d23e23b5329976291d26cc36c6a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK&#160;&#160;&#160;0x00000004U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Intr enable. </p>

</div>
</div>
<a class="anchor" id="ga8f0a12cb3bfff490af76bc9a3ffca4be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_CONTROL_OFFSET&#160;&#160;&#160;0x08U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Timer Control Register. </p>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#ga56d8c36e4aa28168de3ba5d7f87feb2d">XScuTimer_GetPrescaler()</a>, <a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest()</a>, <a class="el" href="group__scutimer__v2__1.html#gac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler()</a>, <a class="el" href="group__scutimer__v2__1.html#gabf24fad576d3adab4b53eebdef424bde">XScuTimer_Start()</a>, and <a class="el" href="group__scutimer__v2__1.html#gaac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop()</a>.</p>

</div>
</div>
<a class="anchor" id="ga867b2da6f5e9b1d921c34a925d4b498a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_CONTROL_PRESCALER_MASK&#160;&#160;&#160;0x0000FF00U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Prescaler. </p>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#ga56d8c36e4aa28168de3ba5d7f87feb2d">XScuTimer_GetPrescaler()</a>, and <a class="el" href="group__scutimer__v2__1.html#gac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa96f9778b3fb95bb968793b504bee53e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_COUNTER_OFFSET&#160;&#160;&#160;0x04U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Timer Counter Register. </p>

</div>
</div>
<a class="anchor" id="ga29b90dcea87e70190d47c53e89977c8a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_DisableAutoReload</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr,              \</div>
<div class="line">                        <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>,                       \</div>
<div class="line">                        (<a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) &amp;             \</div>
<div class="line">                                ~(<a class="code" href="group__scutimer__v2__1.html#gaeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a>)))</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga8f0a12cb3bfff490af76bc9a3ffca4be"><div class="ttname"><a href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_OFFSET</div><div class="ttdoc">Timer Control Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:77</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_gaeaf7add0552b3b0c5ab78b6668a88d6a"><div class="ttname"><a href="group__scutimer__v2__1.html#gaeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</div><div class="ttdoc">Auto-reload. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:92</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga6f29815a4f21529bfc3d009932d3c2fe"><div class="ttname"><a href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a></div><div class="ttdeci">#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)</div><div class="ttdoc">Write to the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:276</div></div>
</div><!-- fragment -->
<p>Disable auto-reload mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#ga29b90dcea87e70190d47c53e89977c8a" title="Disable auto-reload mode. ">XScuTimer_DisableAutoReload(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gac3ea67683ec802381c4aef819d04768b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_DisableInterrupt</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr,              \</div>
<div class="line">                        <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>,                       \</div>
<div class="line">                        (<a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) &amp;             \</div>
<div class="line">                                ~(<a class="code" href="group__scutimer__v2__1.html#ga62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a>)))</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga8f0a12cb3bfff490af76bc9a3ffca4be"><div class="ttname"><a href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_OFFSET</div><div class="ttdoc">Timer Control Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:77</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga62c9d23e23b5329976291d26cc36c6a6"><div class="ttname"><a href="group__scutimer__v2__1.html#ga62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</div><div class="ttdoc">Intr enable. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:91</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga6f29815a4f21529bfc3d009932d3c2fe"><div class="ttname"><a href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a></div><div class="ttdeci">#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)</div><div class="ttdoc">Write to the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:276</div></div>
</div><!-- fragment -->
<p>Disable the Timer interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gac3ea67683ec802381c4aef819d04768b" title="Disable the Timer interrupt. ">XScuTimer_DisableInterrupt(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga54fc490ff5bdcfa76eddddf5fc5dc5bf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_EnableAutoReload</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr,              \</div>
<div class="line">                        <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>,                       \</div>
<div class="line">                        (<a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) |              \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#gaeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a>))</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga8f0a12cb3bfff490af76bc9a3ffca4be"><div class="ttname"><a href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_OFFSET</div><div class="ttdoc">Timer Control Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:77</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_gaeaf7add0552b3b0c5ab78b6668a88d6a"><div class="ttname"><a href="group__scutimer__v2__1.html#gaeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</div><div class="ttdoc">Auto-reload. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:92</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga6f29815a4f21529bfc3d009932d3c2fe"><div class="ttname"><a href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a></div><div class="ttdeci">#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)</div><div class="ttdoc">Write to the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:276</div></div>
</div><!-- fragment -->
<p>Enable auto-reload mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#ga54fc490ff5bdcfa76eddddf5fc5dc5bf" title="Enable auto-reload mode. ">XScuTimer_EnableAutoReload(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga41e184373a4d02ce8a9aec1601a52c04"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_EnableInterrupt</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr,              \</div>
<div class="line">                        <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>,                       \</div>
<div class="line">                        (<a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \</div>
<div class="line">                                        <a class="code" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) |     \</div>
<div class="line">                                        <a class="code" href="group__scutimer__v2__1.html#ga62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a>))</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga8f0a12cb3bfff490af76bc9a3ffca4be"><div class="ttname"><a href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_OFFSET</div><div class="ttdoc">Timer Control Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:77</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga62c9d23e23b5329976291d26cc36c6a6"><div class="ttname"><a href="group__scutimer__v2__1.html#ga62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a></div><div class="ttdeci">#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</div><div class="ttdoc">Intr enable. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:91</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga6f29815a4f21529bfc3d009932d3c2fe"><div class="ttname"><a href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a></div><div class="ttdeci">#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)</div><div class="ttdoc">Write to the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:276</div></div>
</div><!-- fragment -->
<p>Enable the Timer interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#ga41e184373a4d02ce8a9aec1601a52c04" title="Enable the Timer interrupt. ">XScuTimer_EnableInterrupt(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga1427e7cc324917e9bc062ea9cc1976ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_GetControlReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Returns the current timer load register value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Contents of the timer load register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__scutimer__v2__1.html#ga1427e7cc324917e9bc062ea9cc1976ac" title="Returns the current timer load register value. ">XScuTimer_GetControlReg(u32 BaseAddr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga65cf8fca671de7e21a9944c43bf7cd8a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_GetCounterReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Returns the current timer counter register value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Contents of the timer counter register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__scutimer__v2__1.html#ga65cf8fca671de7e21a9944c43bf7cd8a" title="Returns the current timer counter register value. ">XScuTimer_GetCounterReg(u32 BaseAddr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga494afe8a54f75991a1e63fcef913df41"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_GetCounterValue</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr,               \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>)</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_gaa96f9778b3fb95bb968793b504bee53e"><div class="ttname"><a href="group__scutimer__v2__1.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_COUNTER_OFFSET</div><div class="ttdoc">Timer Counter Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:76</div></div>
</div><!-- fragment -->
<p>Returns the current timer counter register value. </p>
<p>It can be called at any time.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Contents of the timer counter register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__scutimer__v2__1.html#ga494afe8a54f75991a1e63fcef913df41" title="Returns the current timer counter register value. ">XScuTimer_GetCounterValue(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gab653a0c97cfb913f3cabeaa3a9167586"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_GetInterruptStatus</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr,               \</div>
<div class="line">                        <a class="code" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>)</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga79f4aab3a1968e66ae1fadb846e7b8c8"><div class="ttname"><a href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_ISR_OFFSET</div><div class="ttdoc">Timer Interrupt Status Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:78</div></div>
</div><!-- fragment -->
<p>This function reads the interrupt status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gab653a0c97cfb913f3cabeaa3a9167586" title="This function reads the interrupt status. ">XScuTimer_GetInterruptStatus(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga48d158b4cc15416e7d4a62867720b79a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_GetIntrReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Returns the current timer counter register value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Contents of the timer counter register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__scutimer__v2__1.html#ga48d158b4cc15416e7d4a62867720b79a" title="Returns the current timer counter register value. ">XScuTimer_GetIntrReg(u32 BaseAddr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga3eedf4e335232d3303b1fd3927f10213"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_GetLoadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Returns the current timer load register value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Contents of the timer load register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__scutimer__v2__1.html#ga3eedf4e335232d3303b1fd3927f10213" title="Returns the current timer load register value. ">XScuTimer_GetLoadReg(u32 BaseAddr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaac033729416a2ae86fec784a89a4c653"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_IsExpired</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line">((<a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>) &amp; <a class="code" href="group__scutimer__v2__1.html#gafa21717c99e101943a7075d4e2e30ca1">\</a></div>
<div class="line"><a class="code" href="group__scutimer__v2__1.html#gafa21717c99e101943a7075d4e2e30ca1">				XSCUTIMER_ISR_EVENT_FLAG_MASK</a>) == \</div>
<div class="line">                                <a class="code" href="group__scutimer__v2__1.html#gafa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a>)</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_gafa21717c99e101943a7075d4e2e30ca1"><div class="ttname"><a href="group__scutimer__v2__1.html#gafa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a></div><div class="ttdeci">#define XSCUTIMER_ISR_EVENT_FLAG_MASK</div><div class="ttdoc">Event flag. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:101</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga79f4aab3a1968e66ae1fadb846e7b8c8"><div class="ttname"><a href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_ISR_OFFSET</div><div class="ttdoc">Timer Interrupt Status Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:78</div></div>
</div><!-- fragment -->
<p>Check if the timer has expired. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>TRUE if the timer has expired.</li>
<li>FALSE if the timer has not expired.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: int <a class="el" href="group__scutimer__v2__1.html#gaac033729416a2ae86fec784a89a4c653" title="Check if the timer has expired. ">XScuTimer_IsExpired(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gafa21717c99e101943a7075d4e2e30ca1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_ISR_EVENT_FLAG_MASK&#160;&#160;&#160;0x00000001U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Event flag. </p>

</div>
</div>
<a class="anchor" id="ga79f4aab3a1968e66ae1fadb846e7b8c8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_ISR_OFFSET&#160;&#160;&#160;0x0CU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Timer Interrupt Status Register. </p>

</div>
</div>
<a class="anchor" id="gae86109b8ee86ede103995c458720c743"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSCUTIMER_LOAD_OFFSET&#160;&#160;&#160;0x00U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Timer Load Register. </p>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga94fbce5d53f983ec5cf675cfc97f4f78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_LoadTimer</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr,              \</div>
<div class="line">                        <a class="code" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>, (Value))</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae86109b8ee86ede103995c458720c743"><div class="ttname"><a href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_LOAD_OFFSET</div><div class="ttdoc">Timer Load Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:75</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga6f29815a4f21529bfc3d009932d3c2fe"><div class="ttname"><a href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a></div><div class="ttdeci">#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)</div><div class="ttdoc">Write to the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:276</div></div>
</div><!-- fragment -->
<p>Write to the timer load register. </p>
<p>This will also update the timer counter register with the new value. This macro can be used to change the time-out value.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance. </td></tr>
    <tr><td class="paramname">Value</td><td>is the count to be loaded in to the load register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#ga94fbce5d53f983ec5cf675cfc97f4f78" title="Write to the timer load register. ">XScuTimer_LoadTimer(XScuTimer *InstancePtr, u32 Value)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="gae4c784baaac425e11d6a1184ae44b349"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_In32((BaseAddr) + (RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Read from the given Timer register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the device </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset to be read</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The 32-bit value of the register</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349" title="Read from the given Timer register. ">XScuTimer_ReadReg(u32 BaseAddr, u32 RegOffset)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#ga56d8c36e4aa28168de3ba5d7f87feb2d">XScuTimer_GetPrescaler()</a>, <a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest()</a>, <a class="el" href="group__scutimer__v2__1.html#gac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler()</a>, <a class="el" href="group__scutimer__v2__1.html#gabf24fad576d3adab4b53eebdef424bde">XScuTimer_Start()</a>, and <a class="el" href="group__scutimer__v2__1.html#gaac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf1976650946668999ca5107fef691e53"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_RestartTimer</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__scutimer__v2__1.html#ga94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer</a>((InstancePtr),                              \</div>
<div class="line">                <a class="code" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \</div>
<div class="line">                                        <a class="code" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>))</div>
<div class="ttc" id="group__scutimer__v2__1_html_gae4c784baaac425e11d6a1184ae44b349"><div class="ttname"><a href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a></div><div class="ttdeci">#define XScuTimer_ReadReg(BaseAddr, RegOffset)</div><div class="ttdoc">Read from the given Timer register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:258</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_gae86109b8ee86ede103995c458720c743"><div class="ttname"><a href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a></div><div class="ttdeci">#define XSCUTIMER_LOAD_OFFSET</div><div class="ttdoc">Timer Load Register. </div><div class="ttdef"><b>Definition:</b> xscutimer_hw.h:75</div></div>
<div class="ttc" id="group__scutimer__v2__1_html_ga94fbce5d53f983ec5cf675cfc97f4f78"><div class="ttname"><a href="group__scutimer__v2__1.html#ga94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer</a></div><div class="ttdeci">#define XScuTimer_LoadTimer(InstancePtr, Value)</div><div class="ttdoc">Write to the timer load register. </div><div class="ttdef"><b>Definition:</b> xscutimer.h:203</div></div>
</div><!-- fragment -->
<p>Re-start the timer. </p>
<p>This macro will read the timer load register and writes the same value to load register to update the counter register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gaf1976650946668999ca5107fef691e53" title="Re-start the timer. ">XScuTimer_RestartTimer(XScuTimer *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gae0b71c6aa97a846b93c4a5fa2092be9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_SetControlReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, (Value))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Write to the timer load register. </p>
<p>This will also update the timer counter register with the new value. This macro can be used to change the time-out value.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer. </td></tr>
    <tr><td class="paramname">Value</td><td>is the count to be loaded in to the load register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gae0b71c6aa97a846b93c4a5fa2092be9e" title="Write to the timer load register. ">XScuTimer_SetControlReg(u32 BaseAddr, u32 Value)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga162738ee853ef5fc9c4fa35bf9c2bb8d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_SetCounterReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>, (Value))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Write to the timer counter register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer. </td></tr>
    <tr><td class="paramname">Value</td><td>is the count to be loaded in to the counter register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#ga162738ee853ef5fc9c4fa35bf9c2bb8d" title="Write to the timer counter register. ">XScuTimer_SetCounterReg(u32 BaseAddr, u32 Value)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaffc9febb953169fb57818c4c58fd68fc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_SetIntrReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>, (Value))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Write to the timer counter register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer. </td></tr>
    <tr><td class="paramname">Value</td><td>is the count to be loaded in to the counter register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gaffc9febb953169fb57818c4c58fd68fc" title="Write to the timer counter register. ">XScuTimer_SetIntrReg(u32 BaseAddr, u32 Value)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gae3cd5f68d2ce17dd72a4abaf4afe06a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_SetLoadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>, (Value))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Write to the timer load register. </p>
<p>This will also update the timer counter register with the new value. This macro can be used to change the time-out value.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the scu timer. </td></tr>
    <tr><td class="paramname">Value</td><td>is the count to be loaded in to the load register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#gae3cd5f68d2ce17dd72a4abaf4afe06a6" title="Write to the timer load register. ">XScuTimer_SetLoadReg(u32 BaseAddr, u32 Value)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga6f29815a4f21529bfc3d009932d3c2fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XScuTimer_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Data&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_Out32((BaseAddr) + (RegOffset), (Data))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&gt;</code></p>

<p>Write to the given Timer register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddr</td><td>is the base address of the device </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset to be written </td></tr>
    <tr><td class="paramname">Data</td><td>is the 32-bit value to write to the register</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe" title="Write to the given Timer register. ">XScuTimer_WriteReg(u32 BaseAddr, u32 RegOffset, u32 Data)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__scutimer__v2__1.html#gac3036b3f9f6e7735d3e6a6eb74a28e95">XScuTimer_SelfTest()</a>, <a class="el" href="group__scutimer__v2__1.html#gac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler()</a>, <a class="el" href="group__scutimer__v2__1.html#gabf24fad576d3adab4b53eebdef424bde">XScuTimer_Start()</a>, and <a class="el" href="group__scutimer__v2__1.html#gaac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga59badd651be237aab4099cedd96621d2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XScuTimer_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&#160;</td>
          <td class="paramname"><em>ConfigPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>EffectiveAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8c.html">xscutimer.c</a>&gt;</code></p>

<p>Initialize a specific timer instance/driver. </p>
<p>This function must be called before other functions of the driver are called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance. </td></tr>
    <tr><td class="paramname">ConfigPtr</td><td>points to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> configuration structure. </td></tr>
    <tr><td class="paramname">EffectiveAddress</td><td>is the base address for the device. It could be a virtual address if address translation is supported in the system, otherwise it is the physical address.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
<li>XST_DEVICE_IS_STARTED if the device has already been started.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a>, <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a>, <a class="el" href="struct_x_scu_timer___config.html#a5dd6111c3cec690eb023ef2e25dadb35">XScuTimer_Config::DeviceId</a>, <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a>, and <a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">XScuTimer::IsStarted</a>.</p>

</div>
</div>
<a class="anchor" id="ga56d8c36e4aa28168de3ba5d7f87feb2d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XScuTimer_GetPrescaler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8c.html">xscutimer.c</a>&gt;</code></p>

<p>This function returns the current prescaler value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The prescaler value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a>, <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a>, <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a>, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, <a class="el" href="group__scutimer__v2__1.html#ga867b2da6f5e9b1d921c34a925d4b498a">XSCUTIMER_CONTROL_PRESCALER_MASK</a>, and <a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga1e7db0f5795151c2d6538dae1fd07a16"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> * XScuTimer_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>

<p>Lookup the device configuration based on the unique device ID. </p>
<p>The table contains the configuration info for each device in the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the device being looked up.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="gac3036b3f9f6e7735d3e6a6eb74a28e95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XScuTimer_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&gt;</code></p>

<p>Run a self-test on the timer. </p>
<p>This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if self-test was successful.</li>
<li>XST_FAILURE if self test was not successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a>, <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a>, <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a>, <a class="el" href="group__scutimer__v2__1.html#ga242deea9cc62049619bdfd97e7a731f4">XSCUTIMER_CONTROL_ENABLE_MASK</a>, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, <a class="el" href="group__scutimer__v2__1.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>, <a class="el" href="group__scutimer__v2__1.html#ga94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer</a>, <a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>, and <a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gac6cd65141b00c0d1940d0b8f2a081faf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XScuTimer_SetPrescaler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>PrescalerValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8c.html">xscutimer.c</a>&gt;</code></p>

<p>This function sets the prescaler bits in the timer control register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance. </td></tr>
    <tr><td class="paramname">PrescalerValue</td><td>is a 8 bit value that sets the prescaler to use.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a>, <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a>, <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a>, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, <a class="el" href="group__scutimer__v2__1.html#ga867b2da6f5e9b1d921c34a925d4b498a">XSCUTIMER_CONTROL_PRESCALER_MASK</a>, <a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>, and <a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gabf24fad576d3adab4b53eebdef424bde"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XScuTimer_Start </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8c.html">xscutimer.c</a>&gt;</code></p>

<p>Start the timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a>, <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a>, <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a>, <a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">XScuTimer::IsStarted</a>, <a class="el" href="group__scutimer__v2__1.html#ga242deea9cc62049619bdfd97e7a731f4">XSCUTIMER_CONTROL_ENABLE_MASK</a>, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, <a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>, and <a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gaac0376fbfeb5c29bb44403d6fefd0843"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XScuTimer_Stop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer_8c.html">xscutimer.c</a>&gt;</code></p>

<p>Stop the timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html" title="The XScuTimer driver instance data. ">XScuTimer</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a>, <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a>, <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a>, <a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">XScuTimer::IsStarted</a>, <a class="el" href="group__scutimer__v2__1.html#ga242deea9cc62049619bdfd97e7a731f4">XSCUTIMER_CONTROL_ENABLE_MASK</a>, <a class="el" href="group__scutimer__v2__1.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, <a class="el" href="group__scutimer__v2__1.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>, and <a class="el" href="group__scutimer__v2__1.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="gac54aa07186803163582a0d3c4f96a686"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> XScuTimer_ConfigTable[XPAR_XSCUTIMER_NUM_INSTANCES]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__sinit_8c.html">xscutimer_sinit.c</a>&gt;</code></p>

<p>This table contains configuration information for each timer device in the system. </p>

</div>
</div>
<a class="anchor" id="gac54aa07186803163582a0d3c4f96a686"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> XScuTimer_ConfigTable[XPAR_XSCUTIMER_NUM_INSTANCES]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xscutimer__g_8c.html">xscutimer_g.c</a>&gt;</code></p>
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line">        {</div>
<div class="line">                (u16)XPAR_XSCUTIMER_0_DEVICE_ID,</div>
<div class="line">                (u32)XPAR_XSCUTIMER_0_BASEADDR</div>
<div class="line">        }</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>This table contains configuration information for each timer device in the system. </p>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
